Skip to main content

List STOP Payments

Retrieves STOP Payments (Standing Orders) created on the platform.
• If accountId is passed, returns STOP Payments (standing orders) for that account.
• If accountId is not passed, returns all STOP Payments across the platform.

Method: POST​

{{URL}}/jsonrpc

Headers​

NameValue
Content-Typeapplication/json

Example​

Payload Parameters
ParameterDescription
methodString
Name of the API method to be invoked. Must be "SmartContractService.ListStandingOrder"
idString
Unique identifier for the request, used for tracking
params.payload.pageInteger
Page number for paginated results. Starts from 0
params.payload.sizeInteger
Number of records to retrieve per page
params.payload.accountIdString
Account ID for which the standing orders are being listed
params.api.credentialString
Authentication credential/token used for API access
params.api.signatureString
Cryptographic signature for securing the API call
params.api.apiKeyString
API key assigned to the application/client
params.api.keyIdString
Device or key identifier used in authentication

Body​

{
  "method": "SmartContractService.ListStandingOrder",
  "id": "1",
  "params": {
    "payload": {
      "page": 0,
      "size": 10,
      "accountId": "4032002"
    },
    "api": {
      "credential": "{{cred}}",
      "signature": "{{signature}}",
      "apiKey": "{{ApiKey}}",
      "keyId": "{{DeviceID}}"
    }
  }
}



Response: 200​

Payload Parameters
ParameterDescription
idString
Identifier that matches the original request ID.
jsonrpcString
JSON-RPC protocol version. Typically set to "2.0".
result[]Array
List of standing order objects. Each object contains:
result[].IDString
Unique identifier for the standing order.
result[].accountNumberString
Account Number associated with the standing order.
result[].createdByString
Email/user ID of the creator of the standing order.
result[].createdDateString (ISO 8601)
Timestamp when the standing order was created.
result[].updatedDateString (ISO 8601)
Timestamp when the standing order was last updated.
result[].contractIdString
Contract ID linked to the standing order.
result[].customerIdString
Unique identifier of the customer.
result[].customerNameString
Name of the customer.
result[].accountIdString
Account ID where the STOP Payment is being applied.
result[].accountNameString
Name of the account associated with the standing order.
result[].autoProcessBoolean
Indicates if the standing order is auto-processed.
result[].statusString
Current status of the standing order (e.g., "VERIFIED").
result[].validUntilDateString (MM/DD/YYYY)
Expiry date of the STOP payment instruction.
result[].channelString
Must be "STOP_PAYMENTS" for STOP instructions.
result[].transactionTypeString
Type of transaction to stop (e.g., "ACH_IN_DEBIT").
result[].maximumAmountPerTransactionNumber
Maximum amount allowed per transaction before STOP is triggered.
result[].isEnabledBoolean
Indicates if the standing order is currently active.
result[].isDisabledBoolean
Indicates if the standing order has been disabled.
result[].isOneTimeUseBoolean
Indicates if the STOP payment is a single-use action.
result[].originatorNameString
Name of the transaction initiator.
result[].smartContractStatusHistory[]Array
Historical log of status changes. Each entry contains:
result[].smartContractStatusHistory[].statusString
Status label (e.g., "ACTIVATED", "DISABLED").
result[].smartContractStatusHistory[].createdDateString (ISO 8601)
Date when status was applied.
result[].smartContractStatusHistory[].userString
User who performed the action.
result[].currencyString
Currency code (e.g., "USD").
result[].approvedCountInteger
Number of approvals recorded for the standing order.
{
  "id": "1",
  "result": [
    {
      "ID": "6821dee2bff3bf6cf0279674",
      "accountNumber": "653421292157469",
      "createdBy": "gokul.v@dreamfinetxd.com",
      "createdDate": "2025-05-12T11:43:30.082Z",
      "updatedDate": "2025-05-12T11:46:47.63Z",
      "contractId": "TK10000000000009003",
      "customerId": "100000000030005",
      "customerName": "Stella Grace",
      "accountId": "4032002",
      "accountName": "Stop Payments Account",
      "autoProcess": false,
      "status": "VERIFIED",
      "validUntilDate": "5/12/2025",
      "channel": "STOP_PAYMENTS",
      "transactionType": "ACH_IN_DEBIT",
      "maximumAmountPerTransaction": 100,
      "isEnabled": false,
      "isDisabled": true,
      "isOneTimeUse": true,
      "originatorName": "AJ,lee",
      "smartContractStatusHistory": [
        {
          "status": "ACTIVATED",
          "createdDate": "2025-05-12T11:43:30.082Z",
          "user": "gokul.v@dreamfinetxd.com"
        },
        {
          "status": "DISABLED",
          "createdDate": "2025-05-12T11:46:47.63Z",
          "user": "gokul.v@dreamfinetxd.com"
        }
      ],
      "currency": "USD",
      "approvedCount": 0
    }
  ],
  "jsonrpc": "2.0"
}